[HorizonDB] Add restore command by alxhghs · Pull Request #10049 · Azure/azure-cli-extensions

alxhghs · 2026-06-29T22:05:47Z

Description

Adds az horizondb restore to create a new HorizonDB cluster as a point-in-time restore of an existing source cluster.

restore — restore a HorizonDB cluster from a source cluster. Accepts --source-cluster and an optional --restore-time (RFC3339). When --restore-time is omitted it defaults to the current UTC time. The command sends createMode=PointInTimeRestore with the required PointInTimeUTC.

Mirrors the az postgres flexible-server restore convention (--restore-time, optional, default = now, parsed/validated with dateutil).

Note: the service currently requires the restore point to be at least ~5 minutes in the past (a temporary preview buffer), so supply an explicit older --restore-time if a restore very close to "now" is rejected.

Bumps the extension version to 1.0.086 and documents the change in HISTORY.rst / README.md.

Testing

azdev style horizondb — PASSED
azdev linter horizondb — PASSED
HorizonDBClusterMgmtScenarioTest recorded live (create → show → list → update → restore → delete) and verified in playback — PASSED

History Notes

Add support for restoring HorizonDB clusters through az horizondb restore.

🤖 PR Validation — ⚠️ Review suggested

Breaking Changes
⚠️ None

⚠️Azure CLI Extensions Breaking Change Test

⚠️horizondb

rule cmd_name rule_message suggest_message

⚠️ 1001 - CmdAdd horizondb restore cmd horizondb restore added

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

The `az horizondb restore` command sent createMode=PointInTimeRestore and sourceClusterResourceId but omitted pointInTimeUTC, which the service requires (MissingRequiredParameter). Add a `--restore-time` argument (optional, defaults to current UTC time, parse-validated) mirroring `az postgres flexible-server restore`, and pass it as point_in_time_utc. - _params.py: add --restore-time arg with current-time default. - custom_commands.py: parse --restore-time and set point_in_time_utc. - _help.py: add point-in-time restore example. - test: supply a valid restore time (utcnow - 6 min, clearing the 300s preview buffer) and assert createMode; re-record live cassette and commit test log. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-client-tools-bot-prd · 2026-06-29T22:05:49Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️horizondb

rule cmd_name rule_message suggest_message

⚠️ 1001 - CmdAdd horizondb restore cmd horizondb restore added

yonzhan · 2026-06-29T23:06:49Z

HorizonDB

…izondb-restore-operations # Conflicts: # src/horizondb/HISTORY.rst # src/horizondb/azext_horizondb/_params.py

Pan-Qi

please resolve the conflict
please mark as open if this PR is ready for review

kabharati · 2026-07-10T15:27:49Z

Thanks @nachoalonsoportillo for making these changes.

- Clarify restore help/summary wording and examples - Reword source-cluster arg and error message (resource identifier) - Default restore-time to 6 minutes before now during preview when omitted - Update example timestamps Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…izondb-restore-operations # Conflicts: # src/horizondb/HISTORY.rst # src/horizondb/azext_horizondb/commands/custom_commands.py # src/horizondb/azext_horizondb/tests/latest/recordings/test_horizondb_cluster_mgmt.yaml

azure-pipelines · 2026-07-14T20:01:56Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

alxhghs · 2026-07-14T20:02:23Z

please resolve the conflict

please mark as open if this PR is ready for review

Hi @Pan-Qi, I resolved the merge conflict and published the PR

Copilot

Pull request overview

Adds a new az horizondb restore command to create a HorizonDB cluster via point-in-time restore from an existing source cluster, and updates the extension’s docs/tests/versioning to reflect the new capability.

Changes:

Introduces horizondb restore command wiring plus implementation that sets createMode=PointInTimeRestore and sends the restore point timestamp.
Adds new CLI parameters/help for --source-cluster and --restore-time, plus scenario test coverage for restore.
Bumps extension version and documents the change in HISTORY/README.

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/horizondb/setup.py	Bumps extension version.
src/horizondb/README.md	Documents the new `restore` command in the feature list.
src/horizondb/HISTORY.rst	Adds release notes entry for restore support.
src/horizondb/azext_horizondb/tests/latest/test_horizondb_commands.py	Extends scenario test to perform a restore and cleanup.
src/horizondb/azext_horizondb/commands/custom_commands.py	Implements restore logic (source cluster resolution + restore-time parsing).
src/horizondb/azext_horizondb/cluster_commands.py	Registers `horizondb restore` in the command table.
src/horizondb/azext_horizondb/_params.py	Adds `--source-cluster` and `--restore-time` arguments.
src/horizondb/azext_horizondb/_help.py	Adds help + examples for `horizondb restore`.

+def _parse_restore_time(restore_time):
+    import datetime
+    if restore_time is None:
+        # During preview, default to 6 minutes before now to satisfy the minimum 5-minute buffer.
+        return datetime.datetime.now(datetime.timezone.utc).replace(microsecond=0) - datetime.timedelta(minutes=6)
+    from dateutil import parser
+    try:
+        return parser.parse(restore_time)
+    except (ValueError, OverflowError):
+        raise InvalidArgumentValueError(
+            "The restore time value has an incorrect date format. "
+            "Please use ISO8601 format, e.g., 2026-07-15T02:10:00+00:00.")
+


+    if restore_time is None:
+        # During preview, default to 6 minutes before now to satisfy the minimum 5-minute buffer.
+        return datetime.datetime.now(datetime.timezone.utc).replace(microsecond=0) - datetime.timedelta(minutes=6)


+        if self.is_live:
+            from datetime import datetime, timedelta, timezone
+
+            restored_cluster_name = self.create_random_name(CLUSTER_NAME_PREFIX, CLUSTER_NAME_MAX_LENGTH)
+
+            # Restore time must be at least 5 minutes (300s) before the current time during preview.
+            restore_time = (datetime.now(timezone.utc) - timedelta(minutes=6)).replace(microsecond=0).isoformat()
+
+            # Restore cluster
+            restore_result = self.cmd('horizondb restore -g {} -n {} --source-cluster {} --restore-time {}'.format(
+                resource_group, restored_cluster_name, cluster_name, restore_time)).get_output_in_json()
+
+            self.assertEqual(restore_result['name'], restored_cluster_name)
+            self.assertEqual(restore_result['properties']['createMode'], 'PointInTimeRestore')
+
+            # Delete restored cluster
+            self.cmd('horizondb delete -g {} -n {} --yes'.format(resource_group, restored_cluster_name),
+                     checks=NoneCheck())
+


Pan-Qi · 2026-07-15T01:01:08Z

/azp run

azure-pipelines · 2026-07-15T01:01:22Z

Azure Pipelines: Successfully started running 2 pipeline(s).

Pan-Qi · 2026-07-20T05:09:34Z

@alxhghs kindly ping for resolving the failed tests

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

…ight # Conflicts: # src/horizondb/HISTORY.rst

- Normalize --restore-time to a UTC-aware datetime in _parse_restore_time: a value without an explicit offset is interpreted as UTC and an offset-aware value is converted to UTC, so the service never receives a naive/ambiguous datetime. - Run the restore scenario in playback (not just live) so `az horizondb restore` is actually exercised by the recorded cassette. Playback matches on method + URI only, so the computed restore-time is not replay-sensitive. - Add unit tests for _parse_restore_time (default, naive, offset-aware, Z suffix, invalid). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9af6f71f-2404-4076-ba3f-b6730e166e91

a0x1ab · 2026-07-23T18:45:15Z

/azp run

azure-pipelines · 2026-07-23T18:45:30Z

Azure Pipelines: Successfully started running 2 pipeline(s).

Alex Fenwood Hughes and others added 3 commits June 26, 2026 14:16

[HorizonDB] Add restore command

e39a127

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

horizondb: remove committed test results log

4b0f643

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

azure-client-tools-bot-prd Bot added this to the August 2026 (2026-08-04) milestone Jun 29, 2026

yonzhan requested a review from Pan-Qi June 29, 2026 23:06

yonzhan assigned Pan-Qi Jun 29, 2026

yonzhan requested a review from jsntcy June 29, 2026 23:06

Merge remote-tracking branch 'upstream/main' into alxhghs/alexfen-hor…

0e0fa23

…izondb-restore-operations # Conflicts: # src/horizondb/HISTORY.rst # src/horizondb/azext_horizondb/_params.py

Pan-Qi requested changes Jul 7, 2026

View reviewed changes

nachoalonsoportillo suggested changes Jul 10, 2026

View reviewed changes

Alex Fenwood Hughes and others added 2 commits July 14, 2026 11:00

alxhghs marked this pull request as ready for review July 14, 2026 20:01

alxhghs requested review from Pan-Qi and Copilot July 14, 2026 20:01

Copilot started reviewing on behalf of alxhghs July 14, 2026 20:02 View session

Copilot AI reviewed Jul 14, 2026

View reviewed changes

alxhghs and others added 2 commits July 23, 2026 08:52

Potential fix for pull request finding

db7bc2c

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into alxhghs-supreme-fortn…

9a17cfd

…ight # Conflicts: # src/horizondb/HISTORY.rst

alxhghs marked this pull request as draft July 23, 2026 16:49

alxhghs requested a review from nachoalonsoportillo July 23, 2026 20:38

Uh oh!

Conversation

alxhghs commented Jun 29, 2026 • edited by azure-client-tools-agent Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

History Notes

🤖 PR Validation — ⚠️ Review suggested

Uh oh!

azure-client-tools-bot-prd Bot commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yonzhan commented Jun 29, 2026

Uh oh!

Pan-Qi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kabharati commented Jul 10, 2026

Uh oh!

azure-pipelines Bot commented Jul 14, 2026

Uh oh!

alxhghs commented Jul 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Pan-Qi commented Jul 15, 2026

Uh oh!

azure-pipelines Bot commented Jul 15, 2026

Uh oh!

Pan-Qi commented Jul 20, 2026

Uh oh!

a0x1ab commented Jul 23, 2026

Uh oh!

azure-pipelines Bot commented Jul 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

alxhghs commented Jun 29, 2026 •

edited by azure-client-tools-agent Bot

Loading

azure-client-tools-bot-prd Bot commented Jun 29, 2026 •

edited

Loading